home *** CD-ROM | disk | FTP | other *** search
/ Magnum One / Magnum One (Mid-American Digital) (Disc Manufacturing).iso / d20 / fdanlz20.arc / FDANLZ.DOC < prev    next >
Text File  |  1991-05-11  |  9KB  |  274 lines
  1.                 FDANLZ Version 2.00 SYSOP Documentation
  2.                    Copyright 1991    Sanft Consulting
  3.  
  4.  
  5. FDANLZ is written for use with Frontdoor(c) style usage logs.
  6. I use FroDo, but could never find a log analyzer I liked
  7. well enough, so I sat down and wrote this one.  With some help from
  8. five or so Sysops here it is: FDANLZ.
  9.  
  10.  
  11.  
  12.   Purpose
  13. ===========
  14.  
  15. I wrote this for a few specific reasons.
  16.  
  17.     1) I wanted to log everything that happened within FrontDoor but, unless
  18.        I was looking for something in particular, it was not necessary to
  19.        browse the entire file every day.
  20.  
  21.     2) I wanted a separate file to show all Fatal FroDo errors and
  22.        another file to show all Transmissions.
  23.     
  24.     3) I did not like to keep adding to the current log file, making it even
  25.        harder to keep track of goings on.
  26.  
  27.     4) I did not like to keep these huge log files on disk if I did not
  28.        need them.  I needed a way to ZIP them up.        
  29.     
  30. o FDANLZ takes your current FroDo log file and creates the same file in your
  31.   target directory, only it will change the name to FDLOG with an extension
  32.   of day of year just like nodelists.  
  33.  
  34. o It will also track all interally encountered errors in FDANLZ.ERR        
  35.  
  36. o It can write all fatal errors to a file called FDFATAL.ERR and all
  37.   transmission information into a file called FDTRANS with an extension of
  38.   day of year.  (Optional)
  39.  
  40. o When it is all done it can delete your old log file (Optional).
  41.  
  42. o It can also ZIP your log file for the day to save space (Optional).
  43.  
  44.  
  45.   Usage
  46. ==========
  47.  
  48. This program can be run on any FroDo style log and is very configurable.
  49.  
  50.  
  51.  SETUP
  52. =======
  53.  
  54. FDANLZ comes with 3 files:
  55.  
  56. FDANLZ.DOC       This Document
  57.  
  58. FDANLZ.EXE       Main Program
  59.  
  60. FDANLZ.CFG       System Information (See below)
  61.  
  62.  
  63.  The FDANLZ.CFG file
  64. =====================
  65.  
  66. This file is a 6-line file that holds the following information:
  67.  
  68. Line #1 : Complete path and file name to your FroDo log file.
  69.  
  70. Line #2 : Add all Fatal errors to FDFATAL.ERR. (Y or N)
  71.  
  72. Line #3 : Write File Transmission info to FDTRANS.(Day_of_year).  
  73.  
  74. Line #4 : Delete your FroDo log file when Done. 
  75.  
  76. Line #5 : Zip daily log file into Monthly or Daily .Zip file 
  77.           Select M for Monthly, D for Daily, else N not to run that.        
  78.  
  79. Line #6 : Output path where you want all output files.
  80.  
  81.  
  82. Example:
  83.  
  84. C:\FD\FD.LOG                           :Complete path and file name of log file
  85. Y                                      :Write FATAL errors file  (Y or N)
  86. Y                                      :Write Transmission info  (Y or N)
  87. Y                                      :Delete your log file when done (Y or N)
  88. M                                      :Zip log file for current day (M,D,N)
  89. C:\HOLDLOG\                            :Path for output files.
  90.  
  91.  
  92.  Installation
  93. ==============
  94.  
  95. This is really hard:
  96.  
  97. 1) Set up your FDANLZ.CFG file to your taste.  
  98. 2) Add FDANLZ.EXE to your midnight event.  
  99. 3) Make sure FDANLZ.EXE and FDANLZ.CFG are in same directory.
  100.  
  101. That is about it.
  102.  
  103.  
  104.  Upgrading        
  105. ===========
  106.  
  107. If you are upgrading from v1.20, make sure you modify line 5 to correctly
  108. .Zip the files to your taste.
  109.  
  110.  
  111.  
  112.  
  113.  Status Screen
  114. ===============
  115.  
  116. When you execute FDANLZ, it will give you a Sysop status screen of what 
  117. your selected configuration is.  
  118.  
  119. Example screen :
  120.  
  121.  
  122. FDANLZ 2.00 FroDo analyzer,  (c)1991  Sanft Consulting
  123. FidoNet 1:282/83       <---->       SPUDNET 103:1001/9
  124.  
  125. Options selected:
  126.  
  127. Copying {your_log_file} to {path} FDLOG.{Day_of_year}
  128. Writing Fatal Errors to {path} FDFATAL.ERR                       (If selected)
  129. Writing Transmission information to {path} FDTRANS.{Day_of_year} (If selected)
  130. Deleting (your_log_file)                                         (If selected)
  131. Zipping FDLOG.{Day_of_year} to FDLOG{Day_of_year}.ZIP            (If selected)
  132. Zipping FDLOG.{Day_of_year} to FDLOG{Month}.ZIP                  (If Selected)
  133.  
  134. This screen is informative and helpful for Debugging.  If you are not sure if 
  135. you are passing parameters correctly, simply put a PAUSE in the .BAT file 
  136. running FDANLZ right after FDANLZ is called.  It will let you look at the 
  137. information and make sure everything is configured correctly.
  138.  
  139.  
  140.  Special Considerations
  141. ========================
  142.  
  143. The .EXE and .CFG files must be in the same and current directory.
  144.  
  145. PKZIP(c) must be in your path if you have selected file zipping.
  146.  
  147. Thanks to improved error handling, this program should never freeze because
  148. of an unrecoverable error.  It should exit normally, and will write any errors
  149. to a file called FDANLZ.ERR.
  150.  
  151. If upgrading from v1.20, make sure you check line 5 in FDANLZ.CFG
  152.  
  153. You probably want to configure FroDo to log most or all informational messages.
  154.  
  155.  
  156.  Registration
  157. ==============
  158.  
  159. FDANLZ is released into Shareware.  As you are probably a fellow Sysop if
  160. you have gotten this far, you understand the need for the Shareware concept!
  161. Please support Shareware concept (and me!). If you use this package for longer
  162. then 30 days please send $8 dollars to:
  163.  
  164.             Sanft Consulting
  165.         C/O Magical Mystery BBS
  166.             P.O. Box 7062
  167.             St. Paul, MN  55107
  168.  
  169. This program is not crippled in any way.  It does not beep, bleep, delete 
  170. itself etc.  
  171.  
  172.  
  173.  
  174.  Validation
  175. ============
  176.  
  177. This program was compiled on 05-10-91. The size is 46,652
  178.  
  179. Running  Validate v0.3  (c)1989-1990  McAfee Associates:
  180.  
  181.           File Name: FDANLZ.EXE
  182.                Size: 46,834
  183.                Date: 05-11-1991
  184.  
  185. File Authentication:
  186.      Check Method 1 - ACB4
  187.      Check Method 2 - 0754
  188.  
  189.  
  190.  Warranty
  191. ==========
  192.  
  193. This software package and accompanying documentation are provided
  194. "AS IS", without warranty of any kind.  The entire risk as to the 
  195. results of using this program is assumed by you.
  196.  
  197.  
  198.  Changes
  199. =========
  200.  
  201. 1.00  04-20-91  FDANLZ written, released for BETA testing.
  202.  
  203. 1.10  04-21-91  Changed FDANLZ.SYS to FDANLZ.CFG.  
  204.                 Added the option to ZIP current days log for space saving.              
  205.                 Added extract of $ entries into FDTRANS.
  206.                 Spell checked this document (Oppppss!)
  207.  
  208. 1.20  04-22-91  Put final touches on documentation.
  209.                 Added comments to FDANLZ.CFG.
  210.                 Cleaned up status screen.
  211.                 Released to general public.
  212.                                 
  213. 2.00  05-11-91  Added date stamping to FDFATAL.ERR
  214.                 Added "%" records to FDTRANS.(D_O_Y)
  215.                 Change ZIP file name to FDLOG(D_O_Y).ZIP  
  216.                 Change program flow and commented throughout (Interal)
  217.                 Added FDANLZ.ERR file for internal error logging.
  218.                 Added special trapping for Log file not in correct directory
  219.                 Add Monthly Zip file, now only 12 files a year (FDLOGxx.ZIP)
  220.                 Added ZIP file name FDLOG(Month).ZIP
  221.                 Added Extract of Address Connected to in FDTRANS.(D_O_Y)
  222.                 Revised FDTRANS file to clearly report all transmissions
  223.                 Added spacing to FDTRANS for easier reading.                
  224.                 
  225.  
  226.  
  227.  Credits
  228. =========
  229.  
  230. A special thanks to Stan Hirschman, (1:282/40) who blew an entire Sunday coming
  231. up with ideas and help making what I think is a very clean, helpful program.
  232.  
  233. Frontdoor(c) is copyrighted by Joaquim H. Homrighausen (Thanks JoHo!)
  234. PKZIP(c) is copyrighted by PKWARE Inc.
  235. Quickbasic(c); MS-DOS(c) are copyrighted by MicroSoft Corporation.
  236. Validate v0.3 is copyrighted by McAfee Associates. 
  237.  
  238.  
  239.  Epilogue
  240. ==========
  241.  
  242. I hope you like this package, and if you have any good ideas for it, 
  243. let me hear them.
  244.  
  245. Any questions or problems?  Need a program?                
  246.         
  247. E-mail me (Ted Sanft) on Magical Mystery BBS (612)552-1631 or
  248. Ted Sanft - @FIDONET (1:282/83)   Ted Sanft - @SPUDNET (103:1001/9)
  249.  
  250.  
  251.         
  252.  SpudNet        
  253. =========
  254.  
  255. What is SpudNet?  Glad you asked!  This is from the creator of SpudNet:
  256.  
  257. SpudNet is a new network started for the sole purpose of getting
  258. away from much of the politics and favoritism that goes on in
  259. many nets.  We feel that everyone should be treated fairly and
  260. evenly.
  261.  
  262. Also, we grew tired of the 600 messages a day in many of the regular 
  263. Fido echos.  No one has time to read all of that.  A smaller network 
  264. can bring back good discussion that you can keep up with.
  265.  
  266. If you are interested in further information about SpudNet, you may
  267. F'req SPUDINFO.ZIP or magic name SPUDINFO from:
  268.  
  269.              Tom Krueger, Zone Coordinator
  270.              1:282/56 
  271.  
  272.              103:103/0 North America, 103:1001/0 or 103:1001/3
  273.  
  274.